home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / PROGRAMM / PROGEDIT / 3528.ZIP / CB300.EXE / READ.ME < prev    next >
Text File  |  1992-07-06  |  9KB  |  225 lines
  1. Welcome to Captain Blackbeard.  We hope you will enjoy the high performance
  2. easy to use editor, Captain Blackbeard.  In addition to Captain Blackbeard,
  3. your diskette contains several complimentary programs and files.  The
  4. following is a brief description of these programs.  (Note:  these files are
  5. contained in the self-extracting archive CBX300.EXE)
  6.  
  7. CBMAN.BAT will generate an alphabetic listing of all Captain Blackbeard
  8. features in the file CB.DOC.
  9.  
  10. SGMAN.EXE is the documentation generator.  SGMAN.DOC explains how to use
  11. the generator to generate the Captain Blackbeard manual.
  12.  
  13. BBF.EXE is the Blackbeard formatter distributed with Blackbeard.  It
  14. provides a simple "dot command" style formatting program.  BBF.DOC
  15. describes its use.
  16.  
  17. .FNT are the various font files used in conjunction with BBF.
  18.  
  19. CBFILES.EXE is a directory program that produces output for use with
  20. Captain Blackbeard's compile review processing.
  21.  
  22. GREP.EXE is the standard grep program, except that it generates
  23. information so you can use it in Captain Blackbeard's compile/review
  24. windows.
  25.  
  26. The current language files are for Paradox (thanks Ed Baker!), Ada, C,
  27. C library (cansi.lng -- thanks Barry Drake!) and Fortran 77.
  28. Contributions are welcomed for these languages, or any other you may
  29. use, e.g., Pascal, BASIC.
  30.  
  31. Also included are two error message conversion utilities (thanks Carsten
  32. Schult), for Clipper (CL2CB) and Turbo Pascal (TP2CB).
  33.  
  34. If you are an OEM, e.g., a compiler developer, we are very interested in
  35. having you include Blackbeard with your product.  We are also interested
  36. in developing customized versions of Blackbeard to meet your specific
  37. product requirements.  Please contact us so that we may mutually benefit
  38. from each other expertise.  We are very flexible in our working
  39. arrangements, and understand the dynamic nature of the personal computer
  40. software market.
  41.  
  42. Captain Blackbeard (CB) is a self-contained program.  The documentation
  43. is built into the program itself.  The help and menu system provide
  44. complete information on all of Captain Blackbeard's functions.
  45.  
  46. Alt-H calls up Captain Blackbeard's help system.  Captain Blackbeard's
  47. help system is context sensitive and available for status line prompts
  48. and menu selections.  The help system is hypertext style, allowing you
  49. to move quickly from topic to topic.  The message line at the bottom
  50. lists the help function keys.
  51.  
  52. Introductory help information topics are:
  53.    Running Captain Blackbeard
  54.    System Configuration
  55.    Installation
  56.    Menus
  57.  
  58. The key to using Captain Blackbeard is the menu system.  All of Captain
  59. Blackbeard's functions are available through the menu system.  The Esc
  60. key will pop up the menus.  The menu consists of grouped commands.  Each
  61. menu contains a list of functions and corresponding key bindings.  Help
  62. is available directly on the menu for each topic.
  63.  
  64. Please note that Captain Blackbeard's Manual generator (CBMAN) is uses this
  65. help information and does not produce any additional information.
  66.  
  67. Other topics of general interest are:
  68.    Registration
  69.    History
  70.    Copyright & Redistribution Limitations
  71.    Questions about Blackbeard
  72.  
  73. To run Captain Blackbeard use:
  74.  
  75.       CB <filename>
  76.  
  77. Captain Blackbeard will display the startup screen and ask you for a file to
  78. edit (if one is not present).  For a list of files press just the enter.
  79.  
  80. NOTE: CB with no filename and the save/restore option on will load the
  81. previously edited files.
  82.  
  83. Alt-H will pop up help. Esc will pop up the main menu.
  84. Esc gets you out of both help and menus.
  85.  
  86.  
  87. CAVEAT:  All the supplied programs have been fully tested on a wide
  88. variety of equipment, and to the best of our knowledge there are no
  89. problems -- however, it is in your own best interest to ensure that a
  90. full backup has been taken before trying out any new software --
  91. whatever the source - hence the following disclaimer.
  92.  
  93. DISCLAIMER:  Use of this program acknowledges this disclaimer of
  94. warranty:  "These programs are supplied as is.  Both James K.  Powers,
  95. and his agents disclaim all warranties, express or implied, including,
  96. and without limitation, the warranties of merchantability, and of fitness
  97. of these programs for any purpose.  Neither James K.  Powers nor his
  98. agents, assume liability for any damages, direct or consequential, which
  99. may result from the use of these programs."
  100.  
  101. To register use the file:  FORM.TXT.  Mail the form and your
  102. registration fee to:
  103.  
  104.            J K Powers
  105.            4604 Trafalgar Lane
  106.            Carlsbad, CA  92008
  107.  
  108.  
  109. If UK users have any questions, or wish to register, please contact my
  110. UK distributer:
  111.  
  112.            Barry Drake
  113.            9 New Vale Road
  114.            Colwick, Nottingham.   NG4 2EA
  115.            Ph. (0602) 619044
  116.  
  117. UK users should use the file UKFORM.TXT to register.
  118.  
  119. Thank you for your support.
  120.  
  121. 3.00 new features:
  122.  
  123. Extension Configuration
  124.  
  125. Captain Blackbeard allows you to customize the editing environment based
  126. on the file extension.  For example, a file containing C code with a .C
  127. extension may want the C.LNG file loaded, while a text file .TXT may
  128. want word processing features enabled, such as word wrap.  Captain
  129. Blackbeard uses the filename CB.EXT for the extension definition file.
  130. It searches in the current directory and then in the directory defined
  131. by the CBDIR environment symbol.  The file is organized as follows:
  132.  
  133. .C    cfg=c.cfg     lng=c.lng
  134. .TXT  cfg=txt.cfg   mac=txt.mac
  135. .HLP  cfg=txt.cfg
  136. .SPC  cfg txt.cfg    key=spec.key
  137. ADA   cfg = ada.cfg  lng=ada.lng
  138. .X    key = brief.key
  139.  
  140. Each line specifies the configuration for a particular extension.  When
  141. a file is edited with that extension the specified configuration files
  142. are loaded.  For example, with the above CB.EXT, if a file with a .c
  143. extension was edited, the c.cfg configuration file and c.lng language
  144. file would be loaded; the default macros and default key would also be
  145. loaded.  The line format is:
  146.  
  147. extension cfg_symbol=filename
  148.  
  149. where cfg_symbol is:
  150.  
  151. cfg - configuration
  152. lng - language file
  153. mac - macro file
  154. key - key binding file
  155.  
  156.  
  157. Expanded Bookmark functions:
  158.  
  159.    Set Bookmark
  160.    Show Bookmarks
  161.    Next Bookmark
  162.    Previous Bookmark
  163.    Change Bookmark
  164.    Delete Bookmark
  165.  
  166.  
  167. Abbreviation Expand
  168.  
  169. Expands the previous token if it is in the language file.  Otherwise the
  170. character is inserted into the file.  For example, when Abbreviation
  171. Expand is bound to space and if the language file has an expansion for
  172. br to break, then typing br followed by space will replace br with
  173. break.  Here's a sample of how to use it:
  174.  
  175.    o  Load the cx.lng file into the language window.  
  176.    o  Bind space to Abbreviation Expand
  177.    o  Create a new file
  178.    o  Type if followed by space.  Try some of the other expansions:  sw,
  179.       br.
  180.  
  181. Extended keyboard support
  182.  
  183. Captain Blackbeard supports the extended keyboard codes, such as Ctrl-, F11
  184. and F12.  You can turn this option on using the Options menu.  (Note:  Some
  185. keyboards (international, in particular) do not return extended keyboard
  186. information properly.)
  187.  
  188. File features
  189.  
  190. Version 2.66 did not retain the file date and time on the backup file.  This
  191. meant that when you chose abort editing the file date and time were
  192. different.  Backup files are now restored and created with the proper date
  193. and time.
  194.  
  195. New file options (available on the Options File Options menu.)
  196.  
  197. Auto Create New Files - creates the new file if the file doesn't
  198. exist without prompting you.
  199.  
  200. Show End of Line Characters - this forces the display of the line
  201. terminator, typically a CR and LF.  This feature was added to allow
  202. searching with positioning on "blank lines", conversion of line terminators
  203. (e.g., UNIX expects only a LF)
  204.  
  205. End of Line Designator (on the Settings Menu) - defines the line terminator
  206. to use when new lines are inserted.  This feature allows you to create UNIX
  207. compatible files, i.e., lines that are terminated with just a LF.
  208.  
  209. Binary file editing
  210.  
  211. In binary mode each line is fixed length -- end of line characters are
  212. treated as normal characters.  You should be cautious editing binary
  213. files.  You probably want to turn all character translation off (e.g.,
  214. tabs).  When you toggle Binary to √ it will automatically set the
  215. following editing options:  turns off Trim Spaces and Tab
  216. Compress/Expand; turns on Show Tab Character and Show End of Line
  217. Characters; set End of Line Designator to None; sets insert mode to
  218. overstrike; set Ignore Extraneous EOFs to YES and Break Long Lines to
  219. Always.  Currently Captain Blackbeard supports only rudimentary binary
  220. file editing.  Future versions may expand support if this is a useful
  221. feature.
  222.  
  223.  
  224.  
  225.